This document provides an overview of the CMP 8.15 release with specific focus on the additional functional and non-functional enhancements with respect to CMP 8.14.
This document is aimed at internal and external audiences familiar with CMP, to explain the key features of the release including any changes in how existing functions or processes are working.
With respect to CMP 8.14, CMP 8.15 introduces new functionality as well as changes to existing functionality and non-functional improvements. These changes can be summarised as follows:
Two new bulk actions have been introduced in CMP 8.15, including the Apply Consumer Price Increase bulk action and the Update Attributes bulk action.
Currently there is only an Edit function on the Workflow Properties panel in the Business Configuration console, from where changes can be made to existing workflow properties. In CMP 8.15, it is now possible for users with access to the Business Configuration console to add workflow properties using the new Add function.
In CMP 8.15 it was only possible to add user profiles and assign access to CMP applications and consoles the Admin Console, there was no maintenance capability for existing users. In CMP 8.15, an Edit function has been added to the Users List screen from where existing user profile details and application and console access can be maintained.
Currently, the security level defaults to '9' (Everyone) when creating new price plans, services, and packages, but there is no visibility of this field from the respective add, edit, or view panels in the Business Configuration console. In CMP 8.15, a Security Level drop-down list has been added to the Add and Edit panels, while the View panel Security Level displays the current stored value for the security level of the viewed record.
The following new web service has been introduced in CMP 8.15:
In addition:
The functional and non-functional changes highlighted in section 2 above have had an impact CMP in the following areas:
No new screens have been introduced as part of CMP 8.15.
The Add Refund screen has been updated to include an option to refund to a bank account that has previously been defined against the account. This new Bank option is available for accounts with a manual payment type. The new Bank option is on the Add Refund screen, which is found when the Add Refund option is selected from the Account Summary Financials > Payments lower panel.
The new 'Apply Consumer Price Increase' bulk action that has been introduced in CMP 8.15 has an impact on the recurring service charge within the base package of in-contract active postpaid subscribers. A service charge that has been impacted for a subscription is now visible on the Services bottom panel accessible from the Billing main menu. A price increase is indicated with a red up arrow in the final column.
The Apply Consumer Price Increase bulk action has been introduced in CMP 8.15 to change the monthly recurring charge on multiple subscriptions based on the retail price index or consumer price index (CPI). The CPI increase will be applied to services in active postpaid subscriptions' base packages that are in contract at the proposed CPI increase date. The date of the increase can be a fixed future date or aligned to a specific bill cycle.
The Excel spreadsheet template provided must be populated with a unique identifier to reference the subscription to which the price increase is to be applied. This can be either the subscription identifier or the MSISDN, but not both.
The module properties for the new sabre-manage-consumer-price-increase bulk action allows a period to be defined between CPI increases so that multiple CPI increases cannot be applied to a single subscription within the period defined.
The user requires the WSO2 role bulk-apply-cpi to be able to see the bulk action template and menu option in the Bulk Action Console.
The Update Attributes bulk action has also been introduced in CMP 8.15. This bulk action allows subscription attributes to be supplied for multiple subscriptions. Attribute values can be added or updated depending on whether they exist already or not.
The Excel spreadsheet template provided must be populated with a unique identifier to reference the subscription being updated which can be either the subscription identifier or the MSISDN, but not both. In addition, a minimum of one attribute description and value must be entered on the Excel template.
The user requires the WSO2 role bulk-update-attributes to be able to see the bulk action template and menu option in the Bulk Action Console.
No Bulk Actions have been changed for CMP 8.15.
A Direct Debit Indemnity Claim Advice (DDICA) is a consumer protection mechanism allowing bank account holders to dispute and reverse unauthorized or incorrect direct debit transactions.
A new BACS DDICA daemon has been added in CMP 8.15 to process a Direct Debit Indemnity Claim report coming from the bank or the customer with the disputed transaction. If a BACS DDICA file is received, CMP will process the DDICA as a recurring payment rejection hard decline. This will move the payment type of the account to Manual, from where an agent will decide how to manually resolve the open invoice.
The Bill Print job has been modified to include the functionality of the Bill Print daemon and also implement a recovery step to ensure the job completes after receiving an error. The Bill Print job now includes a Batch stage and an Extract stage to handle the recovery process when the job fails. If it fails at the 'Batch' and 'In Progress' stage, it will set the Batch status to 'Error' so that the Bill Print job can be re-run. If the Extract stage has a status of In Progress or Error, the job will be re-run and the status reset to Batch Complete.
The Recurring Payments job has been enhanced to support a configurable remark against processed payments to provide a better payment description to the end customer. This has resulted in two additional module properties s specified in section 6.5.1.1 below.
No changes have been made to any of the options within the System Management menu option in CMP 8.15.
No changes have been made to any of the options within the System Monitoring menu option in CMP 8.15.
No changes have been made to any of the options within the System Configuration menu option in CMP 8.15.
No changes have been made to any of the options within the System Administrator menu option in CMP 8.15.
A new Add Workflow Event Property panel has been introduced as part of the CMP 8.15 release. The Add Workflow Event Property panel allows users to add workflow event properties by defining the event type and event code for the associated workflow event.
As part of the CMP 8.15 release, the Add Price Plan panel has been updated to allow a security level to be associated with a price plan. In addition, the Edit and View panels have been updated to show the existing security level associated with the price plan. The security level allows the price plans that users see within AgentView to be restricted. Only price plans with a security level equal to or higher that the user's security level can be viewed.
As part of the CMP 8.15 release, the Add Package panel has been updated to allow a security level to be associated with a package. In addition, the Edit and View panels have been updated to show the existing security level associated with the package. The security level allows the packages that users see within AgentView to be restricted. Only packages with a security level equal to or higher that the user's security level can be viewed.
As part of the CMP 8.15 release, the Add Service panel has been updated to allow a security level to be associated with a service. In addition, the Edit and View panels have been updated to show the existing security level associated with the service. The security level allows the services that users see within AgentView to be restricted. Only services with a security level equal to or higher that the user's security level can be viewed.
As part of the CMP 8.15 release, the Add Workflow Event Type panel has been updated to allow a security level to be associated with a workflow event type. In addition, the Edit and View panels have been updated to show the existing security level associated with the workflow event type. The security level allows the workflows that users see within AgentView to be restricted. Only workflows with a security level equal to or higher that the user's security level can be viewed.
The Add Debt Recovery Agency panel has been enhanced in CMP 8.15 to allow alphanumeric values to be specified for the debt recovery agency code.
There are no new Pricing Configuration screens that have been introduced as part of CMP 8.15.
No Pricing Configuration screens have been changed as part of CMP 8.15.
No new SOAP web services have been introduced as part of the CMP 8.15 release.
There was a requirement to check the number of subscriptions associated with a customer's identification, and if the maximum number of subscriptions allowed is exceeded, prevent the subscription from being created. The CreateAccount and CreateSubscription SOAP web services have been enhanced include an additional optional boolean element 'overrideMaxSubscriptions' that will indicate if the requesting entity wants to perform the ‘max subscriptions’ check or not. This element, if set to false, checks the existing ID number against the number of subscriptions with which it is already associated. If set to true, this check is ignored.
A new PUT Subscription Attributes web service has been added to update or replace the subscription attributes added during a bulk action. This allows an array of attribute descriptions and values to be added.
The POST Subscription Services web service request has been updated to include a package code as part of the request. In addition, the Sales Account Id and Salesperson Id elements are now optional, and only one Id can be specified on a request at a time.
The POST One Time Password web service request has been updated with an optional delivery method element. The delivery method indicates the method by which the OTP will be delivered, including SMS and Email.
The GET Consolidated Sales Ledger web service request has been modified to filter on all payment transactions made against an invoice. These include payments with an Open and Closed status, and one-off or recurring payment transactions.
The GET Agreement web service has been updated to return the successful last bill cycle change date in the response. A successful bill cycle change date is returned if the bill cycle has not been cancelled, or there are no errors.
The Create Account web service request has been modified to allow a business account to be created. This includes the addition of the business address details.
No new Business Configuration RESTful web services have been introduced in CMP 8.15.
No RESTful web services have been updated as part of the CMP 8.15 release.
No additional TMF APIs have been provided as part of the CMP 8.15 release.
No changes have been made to integration adapters in CMP 8.15.
The NetEngage-specific adapters are optional components of the CMP deployment that are based on the licence agreement with MDS Global.
No changes have been made to the NetEngage adapter as part of CMP 8.15.
The Openet-specific adapters are optional components of the CMP deployment that are based on the licence agreement with MDS Global.
No changes have been made to the Openet adapter as part of CMP 8.15.
The Lifecycle-specific adapters are optional components of the CMP deployment that are based on the licence agreement with MDS Global.
No changes have been made to the Lifecycle adapter as part of CMP 8.15.
No changes have been made to UK-specific adapters in CMP 8.15.
In addition to functional and non-functional changes and improvements, the CMP 8.15 product also addresses a number of application support issues. This section provides a summary of the issues fixed in this release.
The following issues have been addressed within this release:
| Reference | Area | Description |
|---|---|---|
| CMPIS-3029 | Comms | The ACCOUNTAMOUNTDUE field was not displaying the correct value for the amount due for payment. |
| CMPIS-3027 | User Management | The email address was not being updated in the WSO2 portal user profile for users created through the Admin Console. |
| CMPIS-3022 | Billing | It was observed that not all of the pending invoice records were being processed for a non-subscription invoice run. This issue was noticed at high volumes of pending invoice records. |
| CMPIS-3019 | Provisioning | It was observed that in some cases a price plan change was not ending the old allowances. |
| CMPIS-3017 | Provisioning | The Provisioning job was attempting to insert duplicate records into the Network Request Log History table. |
| CMPIS-3016 | Provisioning | It was observed that some non-network actions were not completing |
| CMPIS-3015 | eSIM | The 10T Tech adaptors were not correctly handling eSIM ICCIDs of less than 19 digits. |
| CMPIS-3007 | Performance | The Allocation Renewal job was observed to perform poorly when under load due to unnecessary queries. |
| CMPIS-3006 | Performance | The Allocation Monitor job was observed to perform poorly when under load due to unnecessary queries. |
| CMPIS-2977 | eSIM | An invalid character at the end of a discard partition was causing the Sales Order Dispatch job to fail when handling eSIM provisioning. |
| CMPIS-2970 | Payments | The Recurring Card Payment job was observed to be pulling an incorrect amount. |
| CMPIS-2969 | Comms | It was observed that a significant number of comms requests were stuck in a status of 'In Progress'. This appeared to be an issue where account level comms and subscription level comms were being sent at the same time. |
| CMPIS-2968 | Payments | When the payment method of an account was changed to direct debit, the system was incorrectly generating a direct debit amendment workflow. |
| CMPIS-2963 | AgentView | The 'Cancel Refund' function security was not working. |
| CMPIS-2962 | REST APIs | The PATCH Subscription Email Address response only contained the attribute changed rather than the email address details of the changed entity. |
| CMPIS-2961 | Billing | When a sales ledger adjustment was raised on an account that contained just one terminated subscription, the adjustment was invoiced as expected and the value of it appeared in the statements section of the bill print file, but the invoice itself did not appear. |
| CMPIS-2960 | Comms | A deadlock was observed within the Credit Control job when creating an associated comms partition. |
| CMPIS-2929 | REST APIs | In the PATCH account email address request, the newEmailAddress element was defined mandatory but shouldn't have been and was inconsistent with the PATCH subscription email address API. |
| CMPIS-2925 | REST APIs | The GET account email addresses response should have returned the elements 'isActive' and 'emailAddressType'. |
| CMPIS-2917 | AgentView | Right clicking on a non-managed serial number in the subscription summary screen gave an error |
| CMPIS-2906 | Billing | It was observed that is a subscription was disconnected a few days after being connected, no normal invoice was produced. |
| CMPIS-2891 | REST APIs | The GET Subscription isEligibleForUpgrade flag was being set incorrectly for subscriptions in credit control. |
The product documentation is available online on the documentation portal. This online portal requires authorised access, which can be obtained by contacting MDS Global support. The documentation is also available as downloadable PDFs as follows:
| Document | Version | Document Changes |
|---|---|---|
| Installation Guide | 1.0 | The High Availability Stack Installation topic has been updated to include changes to the load balancer requirements for Shared Services and SAM Services. |
| Technical Architecture | 1.0 | The High Availability topic has been updated to include changes to the load balancer requirements for Shared Services and SAM Services. |
| CMP Overview | 1.0 | There are no updates to the CMP Overview as part of CMP 8.15. |
| Documentation Overview | 1.0 | There are no updates to the Documentation Overview as part of CMP 8.15. |
| System Administration Guide | 1.0 | There are no updates to the System Admin Guide as part of CMP 8.15. |
| Security Guide | 1.0 | There are no updates to the Security Guide as part of CMP 8.15. |
| AgentView Function Security Guide | 1.0 | There are no updates to the AgentView Function Security Guide as part of CMP.15. |
| Operational Overview | 1.0 | The Users topic has been updated to include mention of the new Edit function. |
| Business Configuration Overview | 1.0 | The new Comms Default fields have been added and missing fields have been updated. |
| Billing Functionality Guide | 1.0 | There are no updates to the Billing Functionality Guide as part of CMP 8.15. |
| Communications Functionality and Configuration Guide | 1.0 | The new Comms Default fields have been added and missing fields have been updated. |
| Propositions Functionality and Configuration Guide | 1.0 | There are no updates to the Propositions Functionality and Configuration Guide as part of CMP 8.15. |
| Payments Functionality Guide | 1.0 | There are no updates to the Payments Functionality Guide as part of CMP 8.15. |
| Extracts Guide | 1.0 | There are no updates to the Extracts Guide as part of CMP 8.15. |
| Purge Guide | 1.0 | There are no updates to the Purge Guide as part of CMP 8.15. |
| Standard Reporting | 1.0 | There are no updates to the Standard Reporting Guide as part of CMP 8.15. |
| Batch Jobs and JSON Schemas Guide | 1.0 | The Batch Jobs and JSON Schemas Guide has been updated to include the changes to the jobs and daemons highlighted above. |
| RESTFul Web Services API Guide | 1.0 | The REST web services guide has been updated based on the changes highlighted in section 3.7.1 above. |
| SOAP Web Services Semantics Guide | 1.0 | The CreateSubscription and CreateAccount SOAP web services have been updated to include the new OverrideMaxSubscriptions logic. |
| Business Configuration RESTFul Web Services API Guide | 1.0 | There are no updates to the Business Configuration RESTFul web services guide as part of CMP 8.15. |
| Glossary | 1.0 | A CPI Glossary item has been added. |
Online help is available in AgentView, Business Configuration, the Administration Console and the Bulk Actions console. The following table summarises the current versions of the online help and the changes since CMP 8.14:
| Online Help | Version | Document Changes |
|---|---|---|
| AgentView | 1.5 | The following topics have been added or updated as a result of changes made to AgentView in CMP 8.15:
|
| Business Configuration | 1.19 | The following changes have resulted in changes to Business Configuration online help:
|
| Administration Console | 1.17 | The following changes have resulted in changes to Administration Console online help:
|
| Bulk Action Console | 1.9 | The following topics have been added in the Bulk Action Console help in CMP 8.15:
|
The CMP 8.15 installer includes the capability to upgrade a CMP 8.14 installation without the loss of configuration or customer data provided that the software, file system and database structure of the installation in question are at no point manually modified.
The CMP 8.15 Installation Guide, and the details below, should be read before attempting the upgrade to CMP 8.15.
It is important that the following sections are read prior to performing the upgrade, specifically the Configuration Changes section, as it may be advisable to backup relevant configuration prior to performing the upgrade to ensure the configuration can be replicated, if necessary, post upgrade.
The incorporation of the Bill Print Daemon into the Bill Print job means that the billing process can now incorporate the Usage Archive job as the final stage after the Bill Print job has successfully completed. This means that the Usage Archive job no longer needs to be run as a separate job after the completion of the billing process and therefore should be removed from any schedule.
It is important that the existing installation is left running before starting the upgrade. There is no reason to shut down any components however service may be affected whilst performing the upgrade.
There are no updates to the Installation Configuration Tool as part of CMP 8.15.
No third party libraries have been updated for CMP 8.15.
No new tables have been added in CMP 8.15.
The following views have been added in CMP 8.15:
No table attributes have been added in CMP 8.15:
No tables or views have been dropped in CMP 8.15.
No table attributes have been dropped in CMP 8.15.
No table attributes have been changed in CMP 8.15:
In CMP 8.14, the recurring payments job used hard coded values in the payment remark field when apply a payment to an account. This remark has been made configurable by adding the following properties to the Recurring Payments module:
The addition of support for one-time password generation and deliver by email, as well as SMS, has introduced a new workflow event property that ultimately controls the communication to the end customer. To support this, the following configuration is required:
ONETIMEPASSWORD field can be used to specify the one-time password in the communicationCOMMS and a property name of one.time.password.email and linked to workflow created in step 2.A number of default fields have been added in CMP 8.15 to support providing billing address details, the next invoice date and a static to allow today's date to be output in end customer communications. To support this, the following configuration is required:
| Field | Value |
|---|---|
| Field Code | TITLE |
| Description | Title |
| Category | Delivery Address |
| Supported Levels | Subscription, Account |
| Data Source | Internal |
| Parameter | field=title |
| Max Field Length | 10 |
| Explanation | This returns the title. |
| Field | Value |
|---|---|
| Field Code | FORENAME |
| Description | Forename |
| Category | Delivery Address |
| Supported Levels | Subscription, Account |
| Data Source | Internal |
| Parameter | field=foreName |
| Max Field Length | 50 |
| Explanation | This returns the forename. |
| Field | Value |
|---|---|
| Field Code | SURNAME |
| Description | Surname |
| Category | Delivery Address |
| Supported Levels | Subscription, Account |
| Data Source | Internal |
| Parameter | field=surname |
| Max Field Length | 50 |
| Explanation | This returns the surname. |
| Field | Value |
|---|---|
| Field Code | ADDRESSLINE1 |
| Description | Address line 1 |
| Category | Delivery Address |
| Supported Levels | Subscription, Account |
| Data Source | Internal |
| Parameter | field=address1 |
| Max Field Length | 60 |
| Explanation | This returns address line 1. |
| Field | Value |
|---|---|
| Field Code | ADDRESSLINE2 |
| Description | Address line 2 |
| Category | Delivery Address |
| Supported Levels | Subscription, Account |
| Data Source | Internal |
| Parameter | field=address2 |
| Max Field Length | 60 |
| Explanation | This returns address line 2. |
| Field | Value |
|---|---|
| Field Code | ADDRESSLINE3 |
| Description | Address line 3 |
| Category | Delivery Address |
| Supported Levels | Subscription, Account |
| Data Source | Internal |
| Parameter | field=address3 |
| Max Field Length | 60 |
| Explanation | This returns address line 3. |
| Field | Value |
|---|---|
| Field Code | ADDRESSLINE4 |
| Description | Address line 4 |
| Category | Delivery Address |
| Supported Levels | Subscription, Account |
| Data Source | Internal |
| Parameter | field=address4 |
| Max Field Length | 60 |
| Explanation | This returns address line 4. |
| Field | Value |
|---|---|
| Field Code | ADDRESSLINE5 |
| Description | Address line 5 |
| Category | Delivery Address |
| Supported Levels | Subscription, Account |
| Data Source | Internal |
| Parameter | field=address5 |
| Max Field Length | 60 |
| Explanation | This returns address line 5. |
| Field | Value |
|---|---|
| Field Code | NEXTINVOICEDATE |
| Description | Next Invoice Date |
| Category | Account |
| Supported Levels | Subscription, Account, Agreement |
| Data Source | Internal |
| Parameter | field=nextInvoiceDate |
| Max Field Length | 10 |
| Explanation | This returns the next invoice date. |
| Field | Value |
|---|---|
| Field Code | ONETIMEPASSWORD |
| Description | One Time Password |
| Category | Workflow |
| Supported Levels | Subscription, Account |
| Data Source | Internal |
| Parameter | field=oneOffPassword |
| Max Field Length | 10 |
| Explanation | This returns a one-time password. |
| Field | Value |
|---|---|
| Field Code | TODAYSDATE |
| Description | Todays date |
| Category | Static Text |
| Supported Levels | Subscription, Account, Agreement, Corporate, Group |
| Data Source | Internal |
| Parameter | Todays date |
| Max Field Length | 14 |
| Explanation | This returns today's date. |
The system property, DEFAULT_CONTRACT_TERM_FROM_CONFIG, has been deprecated and should be removed from the systemProperties table (C7DFREP).